Image Property, SftTreeHeader Object


	SftTreeHeader.Image Property	Softel vdm, Inc.

Defines the graphic displayed in this column header.

Syntax

Get
	VB.NET	refImageObj = object.Image As SftPictureObject
	VB	Set refImageObj = object.Image As SftPictureObject
	C#.NET	SftPictureObject refImageObj = object.Image;
	VC++	ISftPictureObject* refImageObj = object->Image; ISftPictureObject* refImageObj = object->GetImage();
	C	HRESULT object->get_Image(ISftPictureObject** refImageObj);
	Delphi	refImageObj := object.Image : ISftPictureObject;
Put
	VB.NET	object.Image = refImageObj As SftPictureObject
	VB	object.Image = refImageObj As SftPictureObject
	C#.NET	SftPictureObject object.Image = refImageObj;
	VC++	ISftPictureObject* object->Image = refImageObj; void object->PutImage(ISftPictureObject* refImageObj);
	C	HRESULT object->put_Image(ISftPictureObject* refImageObj);
	Delphi	object.Image := refImageObj : ISftPictureObject;

object

A SftTreeHeader object.

refImageObj

Defines the graphic displayed in this column header.

Comments

The Image property defines the graphic displayed in this column header.

All graphics used in a tree control as Image property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for the column headers, so graphics used as Image property are never clipped vertically. To change the column header graphic size, all column header graphics must be removed first by setting the Image property to Nothing (NULL) for each column before assigning new column header graphics.

If the image object refImageObj defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see Bitmap Transparency).

If a column header is disabled (see Header.Enabled property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.

The Image property can be set to the value Nothing (NULL), which removes the graphic from the column header.

The position of the column header graphic is determined by the Header.ImageHAlign, Header.ImageVAlign and Header.TextHAlign properties.